gh-158842: Add Py_SETREF() and Py_XSETREF() to the limited C API - #158843

cc @ngoldbaum @serhiy-storchaka @encukou

Note: _testlimitedcapi.test_py_setref() checks that Py_SETREF/Py_XSETREF() arguments are only evaluated once.

Documentation build overview

📚 cpython-previews | 🛠️ Build #34952784 | 📁 Comparing 7ce90fe against main (9112dae)

  🔍 Preview build  

Could you add them to stable_abi.toml, too?

Could you add them to stable_abi.toml, too?

Oh right... I totally forgot about that. It's for the docs rendering right?

Could you add them to stable_abi.toml, too?

Sure, done. I forgot that we also put macros in stable_abi.toml. I also added Py_CLEAR(). It seems like Py_CLEAR() was added to Python 2.4 (so it's available since limited C API 3.2).

It's for the docs rendering right?

I learned recently that abi3audit uses the toml table as input for a codegen script that generates the abi3audit implementation. I'd also like to use it in PyO3 for static checks. So downstream appreciates it being accurate and updated.

@encukou: Oh, Doc/c-api/refcounting.rst has .. c:function:: void Py_CLEAR(PyObject *o) whereas Misc/stable_abi.toml has [macro.Py_CLEAR].

It makes Sphinx grumpy because it's once documented as a function, and then documented as a macro... Should I change the documentation to document Py_CLEAR() as a macro?

Sphinx error:

sphinx.errors.SphinxParallelError: sphinx.errors.ExtensionError: Handler <function add_annotations at 0x7172f4a81fd0> for event 'doctree-read' threw an exception (exception: Object type mismatch in limited API annotation for Py_CLEAR: 'macro' != 'function')

Maybe leave the existing ones to a different PR. As docs fixes, they're backportable.

I created issue #158886 and PR #158887 to add all old macros of the limited C API to Misc/stable_abi.toml, not only Py_CLEAR() :-)

Check labels / Unresolved review (pull_request): Cancelled after 15m

I'm not sure why this job took 15 minutes. It seems like something went wrong. I clicked on re-run failed jobs.